Skip to content

Conversation

j-mes
Copy link
Owner

@j-mes j-mes commented Sep 11, 2025

This pull request improves the .github/workflows/build.yml CI workflow by adding detailed comments and clarifying configuration for building and deploying the site to GitHub Pages. The changes focus on making the workflow easier to understand and maintain by explaining each step and permission.

Workflow documentation and clarity:

  • Added descriptive comments throughout the workflow to clarify the purpose of each section, job, and step, making it easier for future maintainers to understand the build and deploy process.

Configuration improvements:

  • Clarified permissions required for GitHub Pages deployment and OIDC authentication by adding inline explanations for each permission entry.
  • Documented concurrency settings to explain how overlapping deployments are avoided.
  • Added comments to the Node.js setup and build steps to indicate alignment with project requirements and caching strategy.
  • Provided explicit comments on conditional deployment steps to highlight when deployment actions are executed (only on pushes to main).

@j-mes j-mes merged commit 97e458a into main Sep 11, 2025
2 checks passed
@j-mes j-mes deleted the chore/fix-bloody-workflow branch September 11, 2025 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant